feat: Configure connections using DNS domain names #2047

hessjcg · 2024-07-24T20:41:57Z

The dialer may be configured to use a DNS name to look up the instance
name instead of configuring the connector with the instance name directly.

Add a DNS TXT record for the Cloud SQL instance to a private DNS server
or a private Google Cloud DNS Zone used by your application. For example:

Record type: TXT
Name: prod-db.mycompany.example.com – This is the domain name used by the application
Value: my-project:region:my-instance – This is the instance connection name
Configure the dialer with the cloudsqlconn.WithDNSResolver() option.

Open a database connection using the DNS name:

HOST: The domain name configured in your DNS TXT record.

Base JDBC URL: jdbc:mysql://<HOST>/<DATABASE_NAME>

SOCKET_FACTORY_CLASS: com.google.cloud.sql.mysql.SocketFactory

The full JDBC URL for MySQL should look like this:

String jdbcUrl = "jdbc:mysql://<HOST>/<DATABASE_NAME>?" 
    + "&socketFactory=com.google.cloud.sql.mysql.SocketFactory" 
    + "&user=<MYSQL_USER_NAME>" 
    + "&password=<MYSQL_USER_PASSWORD>";

See also: the Cloud SQL Go Connector implementation

Part of #2043

pandirigoog · 2025-01-22T21:41:12Z

core/src/main/java/com/google/cloud/sql/core/InstanceCheckingTrustManger.java

+    } else {
+      dns = instanceMetadata.getDnsName();
+    }
+
    if (dns == null || dns.isEmpty()) {


String.isNullOrEmptry(dns) ?

pandirigoog · 2025-01-22T21:42:22Z

core/src/main/java/com/google/cloud/sql/core/InternalConnectorRegistry.java

-        "cloudSqlInstance property not set. Please specify this property in the JDBC URL or the "
-            + "connection Properties with value in form \"project:region:instance\"");
+        config.getCloudSqlInstance() != null || config.getDomainName() != null,
+        "cloudSqlInstance property and hostname not set. Please specify"


pandirigoog · 2025-01-22T21:43:38Z

core/src/main/java/com/google/cloud/sql/core/DnsInstanceConnectionNameResolver.java

+    try {
+      return new CloudSqlInstanceName(name);
+    } catch (IllegalArgumentException e) {
+      // Not a well-formed instance name.


shallowing exception ?

use CloudSqlInstanceName.isValidInstanceName() instead.

hessjcg changed the title ~~Gh 2043 configure with dns~~ feat: Configure connections using DNS domain names Aug 8, 2024

hessjcg force-pushed the gh-2043-configure-with-dns branch from 46e95c4 to 9d71720 Compare August 8, 2024 19:28

hessjcg changed the base branch from main to gh-2043-use-jdbc-url-hostname August 8, 2024 19:49

hessjcg force-pushed the gh-2043-configure-with-dns branch from 9d71720 to cc206b2 Compare August 8, 2024 19:51

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from b368416 to baa2494 Compare August 13, 2024 16:43

hessjcg force-pushed the gh-2043-configure-with-dns branch from cc206b2 to b57ca6c Compare August 13, 2024 16:43

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from baa2494 to b4fab59 Compare August 13, 2024 16:57

hessjcg force-pushed the gh-2043-configure-with-dns branch 2 times, most recently from 01c0a38 to 1f3d6b7 Compare August 13, 2024 18:31

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from b4fab59 to 7901caf Compare August 13, 2024 18:33

hessjcg force-pushed the gh-2043-configure-with-dns branch 2 times, most recently from 49c7e38 to f3f362e Compare August 13, 2024 18:38

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from 7901caf to c251493 Compare August 13, 2024 18:38

hessjcg force-pushed the gh-2043-configure-with-dns branch from f3f362e to a0c1b4e Compare August 13, 2024 19:15

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from c251493 to a6c517d Compare August 13, 2024 19:15

hessjcg force-pushed the gh-2043-configure-with-dns branch from a0c1b4e to 8aaa907 Compare August 15, 2024 17:41

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from a6c517d to 040a9d1 Compare August 15, 2024 17:41

hessjcg force-pushed the gh-2043-configure-with-dns branch 2 times, most recently from cf7698a to 7475041 Compare August 16, 2024 15:26

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from 040a9d1 to f9960d9 Compare August 16, 2024 15:26

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from f9960d9 to e8f506c Compare August 30, 2024 17:54

hessjcg force-pushed the gh-2043-configure-with-dns branch from 7475041 to 8ceb527 Compare August 30, 2024 17:54

hessjcg force-pushed the gh-2043-configure-with-dns branch from 8ceb527 to cf79bec Compare September 27, 2024 21:22

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch 2 times, most recently from 3bd264a to fe70759 Compare October 1, 2024 16:07

hessjcg force-pushed the gh-2043-configure-with-dns branch from cf79bec to 170f88f Compare October 1, 2024 16:07

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from fe70759 to b0942f4 Compare January 10, 2025 18:20

hessjcg force-pushed the gh-2043-configure-with-dns branch from 170f88f to 4ad47df Compare January 10, 2025 18:20

hessjcg force-pushed the gh-2043-use-jdbc-url-hostname branch from b0942f4 to 6062f19 Compare January 10, 2025 18:23

hessjcg force-pushed the gh-2043-configure-with-dns branch from 4ad47df to e885216 Compare January 13, 2025 18:47

hessjcg force-pushed the gh-2043-configure-with-dns branch from de8f2dd to 2b909fd Compare January 17, 2025 18:44

hessjcg force-pushed the gh-2043-use-r2dbc-host branch from 0f1d338 to c389387 Compare January 17, 2025 18:59

hessjcg force-pushed the gh-2043-configure-with-dns branch 2 times, most recently from 475ac57 to ca711d8 Compare January 17, 2025 19:41

pandirigoog reviewed Jan 22, 2025

View reviewed changes

hessjcg marked this pull request as ready for review January 23, 2025 16:46

hessjcg force-pushed the gh-2043-configure-with-dns branch from ca711d8 to 3cd89b1 Compare January 23, 2025 16:47

hessjcg requested a review from pandirigoog January 23, 2025 16:55

pandirigoog approved these changes Jan 23, 2025

View reviewed changes

hessjcg force-pushed the gh-2043-configure-with-dns branch from 3cd89b1 to 595bfe3 Compare January 23, 2025 18:10

pandirigoog approved these changes Jan 23, 2025

View reviewed changes

hessjcg force-pushed the gh-2043-use-r2dbc-host branch from c389387 to 69c1d42 Compare January 23, 2025 18:14

hessjcg force-pushed the gh-2043-configure-with-dns branch 2 times, most recently from e0bbb24 to 914dfdb Compare January 23, 2025 18:54

hessjcg force-pushed the gh-2043-use-r2dbc-host branch from 69c1d42 to 367102f Compare January 23, 2025 18:54

jackwotherspoon approved these changes Jan 23, 2025

View reviewed changes

hessjcg force-pushed the gh-2043-use-r2dbc-host branch from 367102f to 3c91ade Compare January 23, 2025 19:23

hessjcg force-pushed the gh-2043-configure-with-dns branch from 914dfdb to 78f1345 Compare January 23, 2025 20:56

hessjcg force-pushed the gh-2043-use-r2dbc-host branch 2 times, most recently from f2bba72 to 221aeac Compare January 23, 2025 21:20

hessjcg force-pushed the gh-2043-configure-with-dns branch from 78f1345 to 06dec39 Compare January 23, 2025 21:20

hessjcg force-pushed the gh-2043-use-r2dbc-host branch from 221aeac to fe9437a Compare January 23, 2025 21:36

hessjcg force-pushed the gh-2043-configure-with-dns branch from 06dec39 to a993bcd Compare January 23, 2025 21:36

feat: Automatically configure connections using DNS. Part of #2043.

93691d5

hessjcg force-pushed the gh-2043-configure-with-dns branch from a993bcd to 93691d5 Compare January 23, 2025 22:05

hessjcg changed the base branch from gh-2043-use-r2dbc-host to main January 23, 2025 22:06

hessjcg enabled auto-merge (squash) January 23, 2025 22:06

hessjcg merged commit cb745f2 into main Jan 23, 2025
15 checks passed

hessjcg deleted the gh-2043-configure-with-dns branch January 23, 2025 22:12

release-please bot mentioned this pull request Jan 24, 2025

chore(main): release 1.23.0 #2108

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Configure connections using DNS domain names #2047

feat: Configure connections using DNS domain names #2047

hessjcg commented Jul 24, 2024 •

edited

Loading

pandirigoog Jan 22, 2025

hessjcg Jan 22, 2025

pandirigoog Jan 22, 2025

hessjcg Jan 23, 2025

pandirigoog Jan 22, 2025

hessjcg Jan 22, 2025

feat: Configure connections using DNS domain names #2047

feat: Configure connections using DNS domain names #2047

Conversation

hessjcg commented Jul 24, 2024 • edited Loading

pandirigoog Jan 22, 2025

Choose a reason for hiding this comment

hessjcg Jan 22, 2025

Choose a reason for hiding this comment

pandirigoog Jan 22, 2025

Choose a reason for hiding this comment

hessjcg Jan 23, 2025

Choose a reason for hiding this comment

pandirigoog Jan 22, 2025

Choose a reason for hiding this comment

hessjcg Jan 22, 2025

Choose a reason for hiding this comment

hessjcg commented Jul 24, 2024 •

edited

Loading